home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 March / EnigmA AMIGA RUN 05 (1996)(G.R. Edizioni)(IT)[!][issue 1996-03][Skylink CD IV].iso / earcd / editor / chktex.rdm < prev    next >
Text File  |  1996-02-22  |  8KB  |  190 lines
  1. Short:    V1.2. Finds typographic errors in LaTeX
  2. Author:   <jensthi@ifi.uio.no> (Jens T. Berger Thielemann)
  3. Uploader: <jensthi@ifi.uio.no> (Jens T. Berger Thielemann)
  4. Version:  1.2
  5. Type:     text/tex
  6. Replaces: text/tex/ChkTeX.lha
  7.  
  8.              #####  ###       ###    ########     ###     ##
  9.            ###   ##  ##        ##       ##          ##   #
  10.           @@         @@ @@@    @@  @@   @@  #######  @@ @
  11.           @@         @@@  @@   @@ @@    @@   ##   #   @@
  12.           &&         &&   &&   &&&&     &&   @@      & &&
  13.            &&&   &&  &&   &&   && &&    &&   @@@@   &   &&
  14.              %%%%%  %%%   %%% %%%  %%%  %%   &&   %%%    %%% v1.2
  15.                                              &&   &
  16.                                             %%%%%%%
  17.  
  18.     This program was written in frustration of that some constructs in
  19. LaTeX  are sometimes non-intuitive, and easy to forget.  It is *not* a
  20. replacement  for  the  built-in  checker in LaTeX; however, it catches
  21. some  typographic  errors  LaTeX oversees.  In other words, it is Lint
  22. for LaTeX.
  23.  
  24.     While written on an Amiga, it is written in ANSI C, so you can use
  25. this at your UN*X/MSDOS/whatever site also.  Full source included.
  26.  
  27.     The  program  also  supports  output  formats suitable for further
  28. processing  by editors or other programs, making errors easy to catch.
  29. An  ARexx  script  for  interfacing  with  SCMSG  (and via that, other
  30. editors)   is   included.   A  special  script  for  CygnusED  and  an
  31. experimental  script  for  GoldED  is included.  An Emacs interface is
  32. also provided via a Perl script.
  33.  
  34.     The  program  itself  does  not  have any machine requirements, an
  35. Amiga  compiled  version  is included which should work on all Amigas.
  36. Of  course,  you'll  need  ARexx  and  SCMSG to benefit from the ARexx
  37. scripts, though.
  38.  
  39.  
  40.  
  41.                              Legal stuff
  42.                              ~~~~~~~~~~~
  43.     ChkTeX,   its  documentation  and  its  installation  scripts  are
  44. copyright (C) 1995-96 Jens T.  Berger Thielemann.
  45.  
  46.     This  program  is  free  software;  you can redistribute it and/or
  47. modify  it  under  the  terms  of  the  GNU  General Public License as
  48. published  by  the  Free  Software Foundation; either version 2 of the
  49. License, or (at your option) any later version.
  50.  
  51.     This  program  is  distributed in the hope that it will be useful,
  52. but  WITHOUT  ANY  WARRANTY;  without  even  the  implied  warranty of
  53. MERCHANTABILITY  or  FITNESS  FOR  A  PARTICULAR PURPOSE.  See the GNU
  54. General Public License for more details.
  55.  
  56.     You  should have received a copy of the GNU General Public License
  57. along   with  this  program;  if  not,  write  to  the  Free  Software
  58. Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  59.  
  60.  
  61.                                New features
  62.                                ~~~~~~~~~~~~
  63. Changes from v1.1:
  64.  
  65.     Added:
  66.         o Warns  about  `"'  and `´' now - advices about use of better
  67.           accenting characters.
  68.         o The  user may now specify own patterns that will be searched
  69.           and warned about.
  70.         o You   may  now  make  it  dump  comments;  sometimes  useful
  71.           (default:  off).
  72.         o Will now search for user-specified patterns.
  73.         o 5-6  other  new  warnings.  We've got a total of 25 warnings
  74.           now!
  75.         o Wildcard   matching  (Amiga  only).   Will  now  match  file
  76.           patterns  internally, which should save a lot of work.  This
  77.           is,  however, platform-specific code - on UNIX boxes this is
  78.           done by the shell.
  79.         o "chktex ?" now gives help, too.
  80.         o Command-line  options  may  be  specified  globally  in  the
  81.           .chktexrc file.
  82.         o You  may now use another string than a single colon to split
  83.           fields  in  the -v0 output format.  This will solve problems
  84.           on machines using colons in path names.
  85.         o VT100 and VT102 support added.  -v2 switch now works on such
  86.           terminals, too.  Checks $TERM environment variable.
  87.         o "Debugging" mode.
  88.         o An  ARexx  script  for  interfacing  with  SCMSG,  the SAS/C
  89.           message browser.
  90.  
  91.     Modified:
  92.         o More  intelligent  .chktexrc  format;  it  is  now in a more
  93.           shell/free-form   style,  thus  more  readable.   Introduced
  94.           C-like  escape  codes (using `!' as escape character instead
  95.           of `\').
  96.         o More logical option names & better option parsing.
  97.         o A few more options, too...
  98.         o Dash-checking has been improved.
  99.         o Better error reporting of program errors; routines have been
  100.           rewritten.
  101.         o ASCII version of the document is discontinued; users needing
  102.           this  product  are  assumed to possess LaTeX (or at least, a
  103.           DVI/PS viewer).
  104.         o Localization  has also been discontinued...:-/ Too much fuzz
  105.           when nobody is willing to write translations.
  106.  
  107.  
  108.                              Installation
  109.                              ~~~~~~~~~~~~
  110.     Amiga users should use the supplied Installer installation script.
  111.  
  112.     If  you  are  using  a different platform, compile and link all .c
  113. files,  and move the binary to a suitable place.  The `.chktexrc' file
  114. should  be  moved to your $HOME directory on UNIX; other platforms may
  115. put  its  directory path in a environment variable named CHKTEXRC.  If
  116. you  wish  to  use  Emacs and have installed Perl; you should copy the
  117. `chktex.pl' file to a suitable place.  This will serve as a filter for
  118. the `compile' mode of Emacs.
  119.  
  120.     You may wish to read the porting part of the main document first.
  121.  
  122.     After   doing   this,   you   may  enhance  ChkTeX'  behaviour  by
  123. reading/editing the `.chktexrc' file.
  124.  
  125.  
  126.                              Availability
  127.                              ~~~~~~~~~~~~
  128.     This  program  will be uploaded to AmiNet and CTAN; thus it can be
  129. found  at  any mirrors of those.  I'm not quite sure where it will end
  130. up  in  CTAN;  probably  in `contrib/support' or similar.  
  131.  
  132.     Please  note that earlier versions of ChkTeX have been uploaded to
  133. Aminet  under  the same archive name, to keep consistent with Aminet's
  134. policy  of  keeping  versions  out of filenames.  Please read the file
  135. `ChkTeX.readme'  (which  is  in  the same directory as the archive) to
  136. find out the version number.
  137.  
  138.     Mirrors  of  both  networks  include  (I've  tried  to  list  only
  139. one/country):
  140.  
  141. Aminet
  142. ======
  143.   Site                                  Directory
  144.   ftp.wustl.edu (USA (MO))              /pub/aminet/text/tex
  145.   ftp.livewire.com.au (Australia)       /pub/aminet/text/tex
  146.   ftp.luth.se (Scandinavia)             /pub/aminet/text/tex
  147.   ftp.eunet.ch (Switzerland)            /pub/aminet/text/tex
  148.   ftp.germany.aminet.org (Germany)      /pub/aminet/text/tex
  149.   aminet.grolier.fr (France)            /pub/aminet/text/tex
  150.   ftp.giga.or.at (Austria)              /pub/aminet/text/tex
  151.   ftp.unina.it (Italy)                  /pub/aminet/text/tex
  152.   ftp.ua.pt (Portugal)                  /pub/aminet/text/tex
  153.   ftp.gui.uva.es (Spain)                /pub/aminet/text/tex
  154.   ftp.doc.ic.ac.uk (UK)                 /pub/aminet/text/tex
  155.  
  156. CTAN
  157. ====
  158.   Site                                  Directory
  159.   ftp.cs.rmit.edu.au  (Australia)       /tex-archive
  160.   ftp.gwdg.de (Deutschland)             /pub/dante
  161.   src.doc.ic.ac.uk (England)            /packages/tex/uk-tex
  162.   kadri.ut.ee (Estonia)                 /pub/tex
  163.   ftp.funet.fi (Finland)                /pub/TeX/CTAN
  164.   ftp.loria.fr (France)                 /pub/unix/tex/ctan
  165.   ftp.center.osaka-u.ac.jp (Japan)      /CTAN
  166.   sunsite.icm.edu.pl (Poland)           /pub/CTAN
  167.   ftpserver.nus.sg (Singapore)          /pub/zi/TeX
  168.   ftp.ee.up.ac.za (South Africa)        /tex-archive
  169.   ftp.muni.cz (The Czech Republic)      /pub/tex/CTAN
  170.   wuarchive.wustl.edu (Missouri, USA)   /packages/TeX
  171.   ftp.univie.ac.at (Österreich)         /packages/tex
  172.   dongpo.math.ncu.edu.tw (Taiwan)       /tex-archive
  173.  
  174.  
  175.                         Contacting the author
  176.                         ~~~~~~~~~~~~~~~~~~~~~
  177.     If  you  wish to contact me for whatever (more tests, bug reports,
  178. suggestions, hellos, smiley's, etc.), write to:
  179.  
  180.   Jens Berger
  181.   Spektrumvn. 4
  182.   N-0666 Oslo
  183.   Norway
  184.  
  185.   E-mail: <jensthi@ifi.uio.no>
  186.  
  187. Any signs of intelligent life is welcomed; that should exclude piracy.
  188.  
  189. Have fun.
  190.